---
title: Toggle
description: A two-state button that can be either on or off.
component: true
kobalte:
    link: https://kobalte.dev/docs/core/components/toggle-button
    api: https://kobalte.dev/docs/core/components/toggle-button#api-reference
---

<ComponentPreview name="toggle-demo" />

## Installation

<Tabs defaultValue="cli">

<TabsList>
    <TabsTrigger value="cli">CLI</TabsTrigger>
    <TabsTrigger value="manual">Manual</TabsTrigger>
    <TabsIndicator class="bg-primary" />
</TabsList>

<TabsContent value="cli">

```bash
npx shadcn-solid@latest add toggle
```

</TabsContent>

<TabsContent value="manual">

<Steps>

<Step>Install the following dependencies:</Step>

```bash
npm install @kobalte/core
```

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource name="toggle" />

<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsContent>

</Tabs>

## Usage

```tsx
import { ToggleButton } from "@/components/ui/toggle"
```

```tsx
<ToggleButton>Toggle</ToggleButton>
```

## Examples

### Outline

<ComponentPreview name="toggle-outline" />

### With Text

<ComponentPreview name="toggle-with-text" />

### Small

<ComponentPreview name="toggle-small" />

### Large

<ComponentPreview name="toggle-large" />

### Disabled

<ComponentPreview name="toggle-disabled" />
